/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.gds.core.model;

import org.neo4j.gds.core.model.Model.CustomInfo;
import org.neo4j.gds.model.ModelConfig;

import java.util.Collection;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Stream;

public interface UserCatalog {
    <D, C extends ModelConfig, I extends CustomInfo> Model<D, C, I> get(
        String modelName,
        Class<D> dataClass,
        Class<C> configClass,
        Class<I> infoClass
    );

    Model<?, ?, ?> getUntyped(String modelName);

    void set(Model<?, ?, ?> model);

    Collection<Model<?, ?, ?>> list();

    Model<?, ?, ?> list(String modelName);

    Stream<Model<?, ?, ?>> streamModels();

    Set<String> availableModelNames();

    boolean exists(String modelName);

    Optional<String> type(String modelName);

    Model<?, ?, ?> drop(String modelName, boolean failOnMissing);

    void removeAllLoadedModels();

    void verifyModelCanBeStored(String modelName, String modelType);

    long size();
}
